You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR improves the consistency and clarity of messages and task descriptions across Hardhat documentation and codebase. The changes include:
In packages/hardhat-core/src/internal/cli/cli.ts:
Refactored the deprecation warning message to be more concise and clear.
In docs/src/content/hardhat-runner/docs/getting-started/index.md:
Updated the task list with more concise and consistent descriptions.
Improved the description of the 'check' task to be more specific.
In packages/hardhat-core/src/builtin-tasks/check.ts:
Clarified the description of the 'check' task to better reflect its purpose.
In docs/src/content/hardhat-runner/docs/guides/tasks.md:
Added an example of running a task with a network parameter to provide more comprehensive guidance.
These changes aim to enhance the user experience by providing more consistent and informative messages throughout the Hardhat ecosystem. The improvements should make it easier for both new and experienced users to understand and use Hardhat's features effectively.
- Refactored deprecation warning in cli.ts for clarity
- Updated task descriptions in getting-started/index.md for consistency
- Clarified 'check' task description in check.ts
- Added network parameter example in tasks.md guide
Detailed changes:
1. cli.ts: Shortened and clarified deprecation warning message
2. getting-started/index.md: Updated task list with more concise and consistent descriptions
3. check.ts: Improved 'check' task description to be more specific
4. tasks.md: Added example of running a task with network parameter
These changes aim to improve the overall consistency and clarity of Hardhat's documentation and messages, making them more user-friendly and informative.
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Hi @kanej, I hope you're doing well! I just wanted to follow up on this pull request to see if there are any updates or if any changes are needed on my end. I'm happy to make any adjustments if necessary. Thanks a lot for your time and consideration!
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR improves the consistency and clarity of messages and task descriptions across Hardhat documentation and codebase. The changes include:
In
packages/hardhat-core/src/internal/cli/cli.ts:In
docs/src/content/hardhat-runner/docs/getting-started/index.md:In
packages/hardhat-core/src/builtin-tasks/check.ts:In
docs/src/content/hardhat-runner/docs/guides/tasks.md:These changes aim to enhance the user experience by providing more consistent and informative messages throughout the Hardhat ecosystem. The improvements should make it easier for both new and experienced users to understand and use Hardhat's features effectively.